home *** CD-ROM | disk | FTP | other *** search
/ Windows 6-Pak - Disc 5 / Windows 6-Pak (InfoMagic) (Disc 5) (1999).ISO / JAVA-Programming-Tools / jtk101c.exe / DISK2 / formtool.ht_ / formtool.ht
Encoding:
Text File  |  1998-08-24  |  9.2 KB  |  276 lines
  1. <html>
  2.   <head>
  3.     <title>Class FormTool - Evans Java Toolkit</title>
  4.     <meta name="description" content="Evans Programming Java Toolkit - FormTool">
  5.     <meta name="keywords" content="formtool, java, tab, gui, next, previous, default, accellerator, key">
  6.     <meta name="DESIGN" content="Evans Programming, Hoffman Estates, IL">
  7.   </head>
  8.  
  9.   <body bgcolor="#FFFFFF" link="#FF0000" vlink="#800000" alink="#FF00FF">
  10.  
  11. <!--INCLUDESTART="JTCLSHDR.TXT"-->
  12.       <center>
  13.         <font face="Arial" size="5" color="0000FF">
  14.           <strong>Evans Programming Java Toolkit</strong><br>
  15.         </font>
  16.       </center>
  17.       
  18.       <center>
  19.         <font size="-2" face="Arial" color="FF0000">
  20.           <strong>
  21.             <a href="../jtkit.htm", target="_top">Java Toolkit Page</a> |
  22.             <a href="../softwr.htm", target="_top">Software</a> |
  23.             <a href="../index.html", target="_top">Home</a><br>
  24.           </strong>
  25.         </font>
  26.       </center>
  27. <!--INCLUDESTOP="JTCLSHDR.TXT"-->
  28. <!--INCLUDESTART="JTPGIDX.TXT"-->
  29.       <center>
  30.         <font size="-2" face="Arial" color="FF0000">
  31.           <strong>
  32.             <a href="#DESCRIPTION">Description</a> |
  33.             <a href="#EXAMPLES">Examples</a> |
  34.             <a href="#CONSTRUCTORS">Constructors</a> |
  35.             <a href="#METHODS">Methods</a>
  36.           </strong>
  37.         </font>
  38.       </center>
  39. <!--INCLUDESTOP="JTPGIDX.TXT"-->
  40. <!--INCLUDESTART="JTPGNAV.TXT"-->
  41.  
  42.     
  43.     <a href="msgbox.htm">Previous</a> 
  44.     <a href="clientio.htm">Next</a> 
  45.     <a href="classidx.htm">Index</a><br>
  46.                                  
  47. <!--INCLUDESTOP="JTPGNAV.TXT"-->
  48.  
  49.     <hr>
  50.     <h1>Class FormTool</h1>
  51.  
  52.     <pre>
  53. public class evans.toolkit.<strong>FormTool</strong> extends java.awt.Frame
  54. {
  55.     // Constructors
  56.     public <strong>FormTool</strong>();
  57.     public <strong>FormTool</strong>(String title);
  58.     
  59.     // Methods
  60.     public void <strong>initialize</strong>(Frame name);
  61.     public void <strong>centerForm</strong>(Frame name);
  62.     public void <strong>setDefault</strong>(Button name);
  63.     public void <strong>frameCheckboxGroup</strong>(CheckboxGroup name, String caption);
  64. }   </pre>
  65.  
  66.     <hr>
  67.     <a name="DESCRIPTION"><img src="descript.gif" width=220 height=60 alt="Description"></a>
  68.     <p>
  69.       Provides a Frame container with the GUI functions that users have come to expect from a graphical interface.
  70.       Allows TAB next and previous, accelerator keys, default button definition, framed
  71.       option groups and a form centering option.
  72.     </p>
  73.  
  74.     <dl>
  75.       <dt><strong>Tab next and tab previous</strong>
  76.       <dd>Allows forwards and backwards navigation through fields
  77.           when [Tab] or [Shift]+[Tab] is pressed.
  78.     </dl>
  79.  
  80.     <dl>
  81.       <dt><strong>Accelerator Keys</strong>
  82.       <dd>Allows any components with a mnemonic label ("&" + Label Name)
  83.           to be automatically navigated to when [Alt]+[mnemonic key] 
  84.           is pressed. Note: A bug in some browsers does not recognize when
  85.           [Alt] is pressed so [Ctrl]+[mnemonic key] is also supported.
  86.     </dl>
  87.  
  88.     <dl>
  89.       <dt><strong>Navigation through option checkboxes</strong>
  90.       <dd>Option buttons framed with frameCheckboxGroup() can
  91.           be navigated through using [left], [right], [up] and [down]
  92.           arrows.
  93.     </dl>
  94.  
  95.     <hr>
  96.     <a name="EXAMPLES"><img src="example.gif" width=220 height=60 alt="Examples"></a>
  97.     <h3>Display a FormTool Frame From A Web Browser</h3>
  98.  
  99.     <pre>
  100.     import java.awt.*;
  101.     import java.applet.*;
  102.     import evans.toolkit.*;
  103.  
  104.     public class OrderForm extends Applet
  105.     {
  106.         oBuildForm = new BuildForm();
  107.         oBuildForm.setBackground(Color.lightGray);
  108.     }
  109.  
  110.     class BuildForm extends FormTool
  111.     {
  112.         final int ENTER = 10;
  113.         final int ESC = 27;
  114.  
  115.         IDD_DIALOG1 builder;
  116.         
  117.         BuildForm()
  118.         {
  119.             //Form Title
  120.             super("Evans Java Toolkit FormTool Frame");
  121.             
  122.             // Create and Layout controls
  123.             setFont(new Font("Arial", Font.PLAIN, 11));
  124.             builder = new IDD_DIALOG1(this);
  125.             builder.CreateControls();
  126.                     
  127.             // Scan frame for components to GUIefy
  128.             initialize(this);
  129.     
  130.             // Center form on screen
  131.             centerForm(this);         
  132.  
  133.             // Set OK button as the default
  134.             setDefault(builder.IDOK);     
  135.         
  136.             // Put option frame around group1 and label it "Payment"
  137.             frameCheckboxGroup(builder.group1, "Payment");
  138.         
  139.             show();
  140.         }
  141.  
  142.         // Code to handle default behavior of [Enter] and [Esc]
  143.         // Note: In this example there are only 2 buttons, OK and Cancel
  144.         public boolean keyDown(Event evt, int iKey)
  145.         {
  146.             if (iKey == ENTER)                
  147.             {                       
  148.                 if (evt.target == builder.IDCANCEL)
  149.                     doDefaultQuit();
  150.                 else
  151.                     doDefaultOK();
  152.                 return true;
  153.             }
  154.             else if (iKey == ESC)             
  155.             {
  156.                 doDefaultQuit();
  157.                 return true;
  158.             }
  159.             return super.keyDown(evt, iKey);
  160.         }
  161.     }</pre>
  162.  
  163.     <hr>
  164.     <a name="CONSTRUCTORS"><img src="constrct.gif" width=220 height=60 alt="Constructors"></a>
  165.  
  166.     <dl>
  167.       <dt><h3>FormTool</h3>
  168.       <dd><code>public <strong>FormTool</strong>();</code>
  169.       <dd><p>Creates a FormTool frame without a title.</p>
  170.     </dl>
  171.  
  172.     <dl>
  173.       <dt><h3>FormTool</h3>
  174.       <dd><code>public <strong>FormTool</strong>(String title);</code>
  175.       <dd><p>Creates a FormTool frame with a title.</p>
  176.  
  177.       <dl>
  178.         <dt><h4>Parameters:</h4>
  179.         <dd><strong>title</strong> - String - The FormTool frame title.
  180.       </dl>
  181.     </dl>
  182.  
  183.     <hr>
  184.     <a name="METHODS"><img src="methods.gif" width=220 height=60 alt="Methods"></a>
  185.  
  186.     <dl>
  187.       <dt><h3>initialize</h3>
  188.       <dd><code><strong>initialize</strong>(Frame name);</code>
  189.       <dd><p>Scans Frame and registers GUI interface components.
  190.           Should be called after all components are created on Frame.</p>
  191.       <dl>
  192.         <dt><h4>Parameters:</h4>
  193.         <dd><strong>name</strong> - Frame - The frame to add GUI capabilities to.
  194.       </dl>
  195.     </dl>
  196.  
  197.     <dl>
  198.       <dt><h3>centerForm</h3>
  199.       <dd><code><strong>centerForm</strong>(Frame name);</code>
  200.       <dd><p>Centers a FormTool Frame.</p>
  201.       <dl>
  202.         <dt><h4>Parameters:</h4>
  203.         <dd><strong>name</strong> - Frame - The FormTool Frame to center.
  204.       </dl>
  205.     </dl>
  206.  
  207.     <dl>
  208.       <dt><h3>setDefault</h3>
  209.       <dd><code><strong>setDefault</strong>(Button name);</code>
  210.       <dd><p>Draws a black line around a button, unless another button has the focus.
  211.           <strong>Note:</strong> The behavior of the default button still has to be provided
  212.           by programming.</p>
  213.       <dl>
  214.         <dt><h4>Parameters:</h4>
  215.         <dd><strong>name</strong> - Button - A button on a FormTool frame that will be the
  216.             default when no other button has the focus.
  217.       </dl>
  218.     </dl>
  219.  
  220.     <dl>
  221.       <dt><h3>frameCheckboxGroup</h3>
  222.       <dd><code><strong>frameCheckboxGroup</strong>(CheckboxGroup name, String caption);</code>
  223.       <dd><p>Creates a 3-D option group frame around the specified CheckboxGroup and adds your String caption
  224.           to it. MAX of 10 option group frames may be defined per FormTool frame.</p>
  225.       <dl>
  226.         <dt><h4>Parameters:</h4>
  227.         <dd><strong>name</strong> - CheckboxGroup - The CheckboxGroup, on a FormTool, to frame.
  228.         <dd><strong>caption</strong> - String - The option group labels' caption.
  229.       </dl>
  230.     </dl>
  231.     
  232.     <hr>
  233.  
  234. <!--INCLUDESTART="JTPGNAV.TXT"-->
  235.  
  236.     
  237.     <a href="msgbox.htm">Previous</a> 
  238.     <a href="clientio.htm">Next</a> 
  239.     <a href="classidx.htm">Index</a><br>
  240.                                  
  241. <!--INCLUDESTOP="JTPGNAV.TXT"-->
  242. <!--INCLUDESTART="JTPGIDX.TXT"-->
  243.       <center>
  244.         <font size="-2" face="Arial" color="FF0000">
  245.           <strong>
  246.             <a href="#DESCRIPTION">Description</a> |
  247.             <a href="#EXAMPLES">Examples</a> |
  248.             <a href="#CONSTRUCTORS">Constructors</a> |
  249.             <a href="#METHODS">Methods</a>
  250.           </strong>
  251.         </font>
  252.       </center>
  253. <!--INCLUDESTOP="JTPGIDX.TXT"-->
  254. <!--INCLUDESTART="JTCLSFTR.TXT"-->
  255.     <center>
  256.       <font size="-2" face="Arial" color="FF0000">
  257.         <strong>
  258.           <a href="../jtkit.htm", target="_top">Java Toolkit Page</a> |
  259.           <a href="../softwr.htm", target="_top">Software</a> |
  260.           <a href="../index.html", target="_top">Home</a><br>
  261.         </strong>
  262.       </font>
  263.     </center>
  264.  
  265.     <p></p>
  266.     <font size="-1">Evans Programming Java Toolkit HTML Document<br>
  267.       Generated March 15, 1998<br>
  268.       Revised Februrary 5, 1999<br>
  269.       Copyright 1998-1999 Evans Programming<br>
  270.       Send comments or corrections to <a href="mailto:davidLevans@megsinet.net">davidLevans@megsinet.net</a>
  271.     </font>
  272. <!--INCLUDESTOP="JTCLSFTR.TXT"-->
  273.  
  274.   </body>
  275. </html>
  276.